<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>    */<a name="line.18"></a>
<FONT color="green">019</FONT>    package org.uimafit.util;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Iterator;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.uima.cas.CAS;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.uima.cas.FSIterator;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.cas.Type;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.cas.impl.Subiterator;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.cas.text.AnnotationFS;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.cas.text.AnnotationIndex;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.jcas.JCas;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.jcas.tcas.Annotation;<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>    /**<a name="line.33"></a>
<FONT color="green">034</FONT>     * Utility methods for convenient access to the {@link JCas}.<a name="line.34"></a>
<FONT color="green">035</FONT>     *<a name="line.35"></a>
<FONT color="green">036</FONT>     * @author Richard Eckart de Castilho<a name="line.36"></a>
<FONT color="green">037</FONT>     */<a name="line.37"></a>
<FONT color="green">038</FONT>    public class JCasUtil<a name="line.38"></a>
<FONT color="green">039</FONT>    {<a name="line.39"></a>
<FONT color="green">040</FONT>            /**<a name="line.40"></a>
<FONT color="green">041</FONT>             * Convenience method to iterator over all annotations of a given type.<a name="line.41"></a>
<FONT color="green">042</FONT>             *<a name="line.42"></a>
<FONT color="green">043</FONT>             * @param &lt;T&gt; the iteration type.<a name="line.43"></a>
<FONT color="green">044</FONT>             * @param jCas a JCas.<a name="line.44"></a>
<FONT color="green">045</FONT>             * @param type the type.<a name="line.45"></a>
<FONT color="green">046</FONT>             * @return An iterable.<a name="line.46"></a>
<FONT color="green">047</FONT>             * @see AnnotationIndex#iterator()<a name="line.47"></a>
<FONT color="green">048</FONT>             */<a name="line.48"></a>
<FONT color="green">049</FONT>            public static &lt;T extends AnnotationFS&gt; Iterable&lt;T&gt; iterate(final JCas jCas,<a name="line.49"></a>
<FONT color="green">050</FONT>                            final Class&lt;T&gt; type)<a name="line.50"></a>
<FONT color="green">051</FONT>            {<a name="line.51"></a>
<FONT color="green">052</FONT>                    return new Iterable&lt;T&gt;()<a name="line.52"></a>
<FONT color="green">053</FONT>                    {<a name="line.53"></a>
<FONT color="green">054</FONT>                            public Iterator&lt;T&gt; iterator()<a name="line.54"></a>
<FONT color="green">055</FONT>                            {<a name="line.55"></a>
<FONT color="green">056</FONT>                                    return JCasUtil.iterator(jCas, type);<a name="line.56"></a>
<FONT color="green">057</FONT>                            }<a name="line.57"></a>
<FONT color="green">058</FONT>                    };<a name="line.58"></a>
<FONT color="green">059</FONT>            }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>            /**<a name="line.61"></a>
<FONT color="green">062</FONT>             * Convenience method to iterator over all annotations of a given type<a name="line.62"></a>
<FONT color="green">063</FONT>             * occurring within the scope of a provided annotation.<a name="line.63"></a>
<FONT color="green">064</FONT>             *<a name="line.64"></a>
<FONT color="green">065</FONT>             * @param &lt;T&gt; the iteration type.<a name="line.65"></a>
<FONT color="green">066</FONT>             * @param container the containing annotation.<a name="line.66"></a>
<FONT color="green">067</FONT>             * @param type the type.<a name="line.67"></a>
<FONT color="green">068</FONT>             * @return A iterable.<a name="line.68"></a>
<FONT color="green">069</FONT>             * @see #selectCovered(Class, AnnotationFS)<a name="line.69"></a>
<FONT color="green">070</FONT>             */<a name="line.70"></a>
<FONT color="green">071</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; iterate(final Class&lt;T&gt; type, final Annotation container)<a name="line.71"></a>
<FONT color="green">072</FONT>            {<a name="line.72"></a>
<FONT color="green">073</FONT>                    return selectCovered(type, container);<a name="line.73"></a>
<FONT color="green">074</FONT>            }<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>            /**<a name="line.76"></a>
<FONT color="green">077</FONT>             * Convenience method to iterator over all annotations of a given type<a name="line.77"></a>
<FONT color="green">078</FONT>             * occurring within the scope of a provided annotation.<a name="line.78"></a>
<FONT color="green">079</FONT>             *<a name="line.79"></a>
<FONT color="green">080</FONT>             * @param &lt;T&gt; the iteration type.<a name="line.80"></a>
<FONT color="green">081</FONT>             * @param jCas a JCas.<a name="line.81"></a>
<FONT color="green">082</FONT>             * @param container the containing annotation.<a name="line.82"></a>
<FONT color="green">083</FONT>             * @param type the type.<a name="line.83"></a>
<FONT color="green">084</FONT>             * @return A iterable.<a name="line.84"></a>
<FONT color="green">085</FONT>             */<a name="line.85"></a>
<FONT color="green">086</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; iterate(final JCas jCas,<a name="line.86"></a>
<FONT color="green">087</FONT>                            final Class&lt;T&gt; type, final Annotation container)<a name="line.87"></a>
<FONT color="green">088</FONT>            {<a name="line.88"></a>
<FONT color="green">089</FONT>                    return selectCovered(jCas, type, container);<a name="line.89"></a>
<FONT color="green">090</FONT>            }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>            /**<a name="line.92"></a>
<FONT color="green">093</FONT>             * Convenience method to iterator over all annotations of a given type<a name="line.93"></a>
<FONT color="green">094</FONT>             * occurring within the scope of a provided annotation (sub-iteration).<a name="line.94"></a>
<FONT color="green">095</FONT>             *<a name="line.95"></a>
<FONT color="green">096</FONT>             * @param &lt;T&gt; the iteration type.<a name="line.96"></a>
<FONT color="green">097</FONT>             * @param jCas a JCas.<a name="line.97"></a>
<FONT color="green">098</FONT>             * @param container the containing annotation.<a name="line.98"></a>
<FONT color="green">099</FONT>             * @param type the type.<a name="line.99"></a>
<FONT color="green">100</FONT>         * @param ambiguous If set to &lt;code&gt;false&lt;/code&gt;, resulting iterator will be unambiguous.<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param strict Controls if annotations that overlap to the right are considered in or out.<a name="line.101"></a>
<FONT color="green">102</FONT>             * @return A sub-iterator iterable.<a name="line.102"></a>
<FONT color="green">103</FONT>             * @see AnnotationIndex#subiterator(AnnotationFS, boolean, boolean)<a name="line.103"></a>
<FONT color="green">104</FONT>             */<a name="line.104"></a>
<FONT color="green">105</FONT>            public static &lt;T extends Annotation&gt; Iterable&lt;T&gt; subiterate(final JCas jCas,<a name="line.105"></a>
<FONT color="green">106</FONT>                            final Class&lt;T&gt; type, final Annotation container, final boolean ambiguous,<a name="line.106"></a>
<FONT color="green">107</FONT>                            final boolean strict)<a name="line.107"></a>
<FONT color="green">108</FONT>            {<a name="line.108"></a>
<FONT color="green">109</FONT>                    return new Iterable&lt;T&gt;()<a name="line.109"></a>
<FONT color="green">110</FONT>                    {<a name="line.110"></a>
<FONT color="green">111</FONT>                            public Iterator&lt;T&gt; iterator()<a name="line.111"></a>
<FONT color="green">112</FONT>                            {<a name="line.112"></a>
<FONT color="green">113</FONT>                                    return JCasUtil.iterator(container, type, ambiguous, strict);<a name="line.113"></a>
<FONT color="green">114</FONT>                            }<a name="line.114"></a>
<FONT color="green">115</FONT>                    };<a name="line.115"></a>
<FONT color="green">116</FONT>            }<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>            /**<a name="line.118"></a>
<FONT color="green">119</FONT>             * Get an iterator over the given annotation type.<a name="line.119"></a>
<FONT color="green">120</FONT>             *<a name="line.120"></a>
<FONT color="green">121</FONT>             * @param &lt;T&gt; the JCas type.<a name="line.121"></a>
<FONT color="green">122</FONT>             * @param jCas a JCas.<a name="line.122"></a>
<FONT color="green">123</FONT>             * @param type a type.<a name="line.123"></a>
<FONT color="green">124</FONT>             * @return a return value.<a name="line.124"></a>
<FONT color="green">125</FONT>             */<a name="line.125"></a>
<FONT color="green">126</FONT>            @SuppressWarnings("unchecked")<a name="line.126"></a>
<FONT color="green">127</FONT>            public static &lt;T extends AnnotationFS&gt; Iterator&lt;T&gt; iterator(JCas jCas,<a name="line.127"></a>
<FONT color="green">128</FONT>                            Class&lt;T&gt; type)<a name="line.128"></a>
<FONT color="green">129</FONT>            {<a name="line.129"></a>
<FONT color="green">130</FONT>                    return ((AnnotationIndex&lt;T&gt;) jCas.getAnnotationIndex(getType(jCas, type))).iterator();<a name="line.130"></a>
<FONT color="green">131</FONT>            }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>            /**<a name="line.133"></a>
<FONT color="green">134</FONT>             * Convenience method to get a sub-iterator for the specified type.<a name="line.134"></a>
<FONT color="green">135</FONT>             *<a name="line.135"></a>
<FONT color="green">136</FONT>             * @param &lt;T&gt; the iteration type.<a name="line.136"></a>
<FONT color="green">137</FONT>             * @param container the containing annotation.<a name="line.137"></a>
<FONT color="green">138</FONT>             * @param type the type.<a name="line.138"></a>
<FONT color="green">139</FONT>         * @param ambiguous If set to &lt;code&gt;false&lt;/code&gt;, resulting iterator will be unambiguous.<a name="line.139"></a>
<FONT color="green">140</FONT>         * @param strict Controls if annotations that overlap to the right are considered in or out.<a name="line.140"></a>
<FONT color="green">141</FONT>             * @return A sub-iterator.<a name="line.141"></a>
<FONT color="green">142</FONT>             */<a name="line.142"></a>
<FONT color="green">143</FONT>            @SuppressWarnings("unchecked")<a name="line.143"></a>
<FONT color="green">144</FONT>            public static &lt;T extends AnnotationFS&gt; Iterator&lt;T&gt; iterator(<a name="line.144"></a>
<FONT color="green">145</FONT>                            Annotation container, Class&lt;T&gt; type, boolean ambiguous, boolean strict)<a name="line.145"></a>
<FONT color="green">146</FONT>            {<a name="line.146"></a>
<FONT color="green">147</FONT>                    CAS cas = container.getCAS();<a name="line.147"></a>
<FONT color="green">148</FONT>                    return ((AnnotationIndex&lt;T&gt;) cas.getAnnotationIndex(CasUtil.getType(cas, type))).subiterator(<a name="line.148"></a>
<FONT color="green">149</FONT>                                    container, ambiguous, strict);<a name="line.149"></a>
<FONT color="green">150</FONT>            }<a name="line.150"></a>
<FONT color="green">151</FONT>    <a name="line.151"></a>
<FONT color="green">152</FONT>            /**<a name="line.152"></a>
<FONT color="green">153</FONT>             * Get the CAS type for the given JCas wrapper class type.<a name="line.153"></a>
<FONT color="green">154</FONT>             *<a name="line.154"></a>
<FONT color="green">155</FONT>             * @param jCas the JCas containing the type system.<a name="line.155"></a>
<FONT color="green">156</FONT>             * @param type the JCas wrapper class type.<a name="line.156"></a>
<FONT color="green">157</FONT>             * @return the CAS type.<a name="line.157"></a>
<FONT color="green">158</FONT>             */<a name="line.158"></a>
<FONT color="green">159</FONT>            public static Type getType(JCas jCas, Class&lt;?&gt; type)<a name="line.159"></a>
<FONT color="green">160</FONT>            {<a name="line.160"></a>
<FONT color="green">161</FONT>                    return CasUtil.getType(jCas.getCas(), type);<a name="line.161"></a>
<FONT color="green">162</FONT>            }<a name="line.162"></a>
<FONT color="green">163</FONT>    <a name="line.163"></a>
<FONT color="green">164</FONT>            /**<a name="line.164"></a>
<FONT color="green">165</FONT>             * Get a list of annotations of the given annotation type constrained by a<a name="line.165"></a>
<FONT color="green">166</FONT>             * 'covering' annotation. Iterates over all annotations of the given type to<a name="line.166"></a>
<FONT color="green">167</FONT>             * find the covered annotations. Does not use subiterators.<a name="line.167"></a>
<FONT color="green">168</FONT>             *<a name="line.168"></a>
<FONT color="green">169</FONT>             * @param &lt;T&gt; the JCas type.<a name="line.169"></a>
<FONT color="green">170</FONT>             * @param type a UIMA type.<a name="line.170"></a>
<FONT color="green">171</FONT>             * @param coveringAnnotation the covering annotation.<a name="line.171"></a>
<FONT color="green">172</FONT>             * @return a return value.<a name="line.172"></a>
<FONT color="green">173</FONT>             * @see Subiterator<a name="line.173"></a>
<FONT color="green">174</FONT>             */<a name="line.174"></a>
<FONT color="green">175</FONT>            public static &lt;T extends AnnotationFS&gt; List&lt;T&gt; selectCovered(<a name="line.175"></a>
<FONT color="green">176</FONT>                            Class&lt;T&gt; type, AnnotationFS coveringAnnotation)<a name="line.176"></a>
<FONT color="green">177</FONT>            {<a name="line.177"></a>
<FONT color="green">178</FONT>                    CAS cas = coveringAnnotation.getCAS();<a name="line.178"></a>
<FONT color="green">179</FONT>                    return CasUtil.selectCovered(cas, CasUtil.getType(cas, type), coveringAnnotation);<a name="line.179"></a>
<FONT color="green">180</FONT>            }<a name="line.180"></a>
<FONT color="green">181</FONT>    <a name="line.181"></a>
<FONT color="green">182</FONT>            /**<a name="line.182"></a>
<FONT color="green">183</FONT>             * Get a list of annotations of the given annotation type constrained by a<a name="line.183"></a>
<FONT color="green">184</FONT>             * 'covering' annotation. Iterates over all annotations of the given type to<a name="line.184"></a>
<FONT color="green">185</FONT>             * find the covered annotations. Does not use subiterators.<a name="line.185"></a>
<FONT color="green">186</FONT>             *<a name="line.186"></a>
<FONT color="green">187</FONT>             * @param &lt;T&gt; the JCas type.<a name="line.187"></a>
<FONT color="green">188</FONT>             * @param jCas a JCas containing the annotation.<a name="line.188"></a>
<FONT color="green">189</FONT>             * @param type a UIMA type.<a name="line.189"></a>
<FONT color="green">190</FONT>             * @param coveringAnnotation the covering annotation.<a name="line.190"></a>
<FONT color="green">191</FONT>             * @return a return value.<a name="line.191"></a>
<FONT color="green">192</FONT>             * @see Subiterator<a name="line.192"></a>
<FONT color="green">193</FONT>             */<a name="line.193"></a>
<FONT color="green">194</FONT>            public static &lt;T extends Annotation&gt; List&lt;T&gt; selectCovered(<a name="line.194"></a>
<FONT color="green">195</FONT>                            JCas jCas, final Class&lt;T&gt; type, Annotation coveringAnnotation)<a name="line.195"></a>
<FONT color="green">196</FONT>            {<a name="line.196"></a>
<FONT color="green">197</FONT>                    return CasUtil.selectCovered(jCas.getCas(), getType(jCas, type), coveringAnnotation);<a name="line.197"></a>
<FONT color="green">198</FONT>            }<a name="line.198"></a>
<FONT color="green">199</FONT>    <a name="line.199"></a>
<FONT color="green">200</FONT>            /**<a name="line.200"></a>
<FONT color="green">201</FONT>             * This method exists simply as a convenience method for unit testing. It is<a name="line.201"></a>
<FONT color="green">202</FONT>             * not very efficient and should not, in general be used outside the context<a name="line.202"></a>
<FONT color="green">203</FONT>             * of unit testing.<a name="line.203"></a>
<FONT color="green">204</FONT>             *<a name="line.204"></a>
<FONT color="green">205</FONT>             * @param &lt;T&gt; JCas wrapper type.<a name="line.205"></a>
<FONT color="green">206</FONT>             * @param jCas<a name="line.206"></a>
<FONT color="green">207</FONT>             * @param cls<a name="line.207"></a>
<FONT color="green">208</FONT>             * @param index<a name="line.208"></a>
<FONT color="green">209</FONT>             *            this can be either positive (0 corresponds to the first<a name="line.209"></a>
<FONT color="green">210</FONT>             *            annotation of a type) or negative (-1 corresponds to the last<a name="line.210"></a>
<FONT color="green">211</FONT>             *            annotation of a type.)<a name="line.211"></a>
<FONT color="green">212</FONT>             * @return an annotation of the given type<a name="line.212"></a>
<FONT color="green">213</FONT>             */<a name="line.213"></a>
<FONT color="green">214</FONT>            @SuppressWarnings("unchecked")<a name="line.214"></a>
<FONT color="green">215</FONT>            public static &lt;T extends Annotation&gt; T selectByIndex(JCas jCas, Class&lt;T&gt; cls, int index) {<a name="line.215"></a>
<FONT color="green">216</FONT>                    FSIterator&lt;Annotation&gt; i = jCas.getAnnotationIndex(getType(jCas, cls)).iterator();<a name="line.216"></a>
<FONT color="green">217</FONT>                    int n = index;<a name="line.217"></a>
<FONT color="green">218</FONT>                    i.moveToFirst();<a name="line.218"></a>
<FONT color="green">219</FONT>                    if (n &gt; 0) {<a name="line.219"></a>
<FONT color="green">220</FONT>                            while (n &gt; 0 &amp;&amp; i.isValid()) {<a name="line.220"></a>
<FONT color="green">221</FONT>                                    i.moveToNext();<a name="line.221"></a>
<FONT color="green">222</FONT>                                    n--;<a name="line.222"></a>
<FONT color="green">223</FONT>                            }<a name="line.223"></a>
<FONT color="green">224</FONT>                    }<a name="line.224"></a>
<FONT color="green">225</FONT>                    if (n &lt; 0) {<a name="line.225"></a>
<FONT color="green">226</FONT>                            i.moveToLast();<a name="line.226"></a>
<FONT color="green">227</FONT>                            while (n &lt; -1 &amp;&amp; i.isValid()) {<a name="line.227"></a>
<FONT color="green">228</FONT>                                    i.moveToPrevious();<a name="line.228"></a>
<FONT color="green">229</FONT>                                    n++;<a name="line.229"></a>
<FONT color="green">230</FONT>                            }<a name="line.230"></a>
<FONT color="green">231</FONT>                    }<a name="line.231"></a>
<FONT color="green">232</FONT>    <a name="line.232"></a>
<FONT color="green">233</FONT>                    return i.isValid() ? (T) i.get() : null;<a name="line.233"></a>
<FONT color="green">234</FONT>            }<a name="line.234"></a>
<FONT color="green">235</FONT>    }<a name="line.235"></a>




























































</PRE>
</BODY>
</HTML>
